<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="TextAnimTools,flupie.textanim.TextAnimTools,getColorBounds,setGradientLinear,setPattern,toBitmap,toVector" name="keywords">
<title>flupie.textanim.TextAnimTools</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'TextAnimTools - TextAnim Documentation';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">TextAnim Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?flupie/textanim/TextAnimTools.html&amp;flupie/textanim/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;TextAnimTools</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class TextAnimTools"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">flupie.textanim</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class TextAnimTools</td>
</tr>
</table>
<p></p>
   Extra tools for special treatment of TextAnim instance. Can convert the blocks to bitmap, apply patterns, etc.
  <p></p>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getColorBounds()">getColorBounds</a>(block:<a href="TextAnimBlock.html">TextAnimBlock</a>):Rectangle</div>
<div class="summaryTableDescription">[static]
  Get color boundsof a TextAnimBlock instance.</div>
</td><td class="summaryTableOwnerCol">TextAnimTools</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setGradientLinear()">setGradientLinear</a>(textAnim:<a href="TextAnim.html">TextAnim</a>, colors:Array, angle:Number = 0, alphas:Array = null, ratios:Array = null):void</div>
<div class="summaryTableDescription">[static]
  A linear gradient as a color of the text.</div>
</td><td class="summaryTableOwnerCol">TextAnimTools</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setPattern()">setPattern</a>(textAnim:<a href="TextAnim.html">TextAnim</a>, img:Boolean, stretch:* = false):void</div>
<div class="summaryTableDescription">[static]
  Takes a display object to draw a texture in each TextAnim block.</div>
</td><td class="summaryTableOwnerCol">TextAnimTools</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#toBitmap()">toBitmap</a>(textAnim:<a href="TextAnim.html">TextAnim</a>, smooth:Boolean = false):void</div>
<div class="summaryTableDescription">[static]
  Convert blocks to Bitmap.</div>
</td><td class="summaryTableOwnerCol">TextAnimTools</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#toVector()">toVector</a>(textAnim:<a href="TextAnim.html">TextAnim</a>):void</div>
<div class="summaryTableDescription">[static]
  If the textAnim instance was converted to bitmap, <code>toVector</code> can reverse it.</div>
</td><td class="summaryTableOwnerCol">TextAnimTools</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="getColorBounds()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getColorBounds</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public static function getColorBounds(block:<a href="TextAnimBlock.html">TextAnimBlock</a>):Rectangle</code><p>
  Get color boundsof a TextAnimBlock instance.
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">block</span>:<a href="TextAnimBlock.html">TextAnimBlock</a></code> &mdash; The block measured.
  </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Rectangle</code></td>
</tr>
</table>
</div>
<a name="setGradientLinear()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setGradientLinear</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function setGradientLinear(textAnim:<a href="TextAnim.html">TextAnim</a>, colors:Array, angle:Number = 0, alphas:Array = null, ratios:Array = null):void</code><p>
  A linear gradient as a color of the text.
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">textAnim</span>:<a href="TextAnim.html">TextAnim</a></code> &mdash; Instance of TextAnim.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">colors</span>:Array</code> &mdash; List of colors of the gradient.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">angle</span>:Number</code> (default = <code>0</code>)<code></code> &mdash; The direction of the gradient (in degrees).
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">alphas</span>:Array</code> (default = <code>null</code>)<code></code> &mdash; The alpha of each color.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">ratios</span>:Array</code> (default = <code>null</code>)<code></code> &mdash; The ratio of each color.
  </td>
</tr>
</table>
</div>
<a name="setPattern()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setPattern</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function setPattern(textAnim:<a href="TextAnim.html">TextAnim</a>, img:Boolean, stretch:* = false):void</code><p>
  Takes a display object to draw a texture in each TextAnim block.
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">textAnim</span>:<a href="TextAnim.html">TextAnim</a></code> &mdash; Instance of TextAnim.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">img</span>:Boolean</code> &mdash; The source off texture bitmap.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">stretch</span>:*</code> (default = <code>false</code>)<code></code> &mdash; To extends the texture dimenions to fill up each block's area, without repetition.
    </td>
</tr>
</table>
</div>
<a name="toBitmap()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">toBitmap</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function toBitmap(textAnim:<a href="TextAnim.html">TextAnim</a>, smooth:Boolean = false):void</code><p>
  Convert blocks to Bitmap. By default, all blocks contains
  one TextField inside, <code>toBitmap</code> tool convert 
  all TextFields to Bitmap.
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">textAnim</span>:<a href="TextAnim.html">TextAnim</a></code> &mdash; Instance of TextAnim.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">smooth</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; Allow smooth bitmap.
  
  </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">toVector</div>
</div>
<a name="toVector()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">toVector</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function toVector(textAnim:<a href="TextAnim.html">TextAnim</a>):void</code><p>
  If the textAnim instance was converted to bitmap, <code>toVector</code> can reverse it.
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">textAnim</span>:<a href="TextAnim.html">TextAnim</a></code> &mdash; Instance of TextAnim.
  
  </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">toBitmap</div>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">(c) Copyright 2009 - MIT LICENSE. All Rights Reserved. http://code.google.com/p/textanim</center>
</div>
</body>
</html>
<!--(c) Copyright 2009 - MIT LICENSE. All Rights Reserved. http://code.google.com/p/textanim-->
